<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpimagesamplepoints: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
<link rel="prev" href="libgimp3-gimpimageguides.html" title="gimpimageguides">
<link rel="next" href="libgimp3-gimpimageselect.html" title="gimpimageselect">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-gimpimagesamplepoints.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp3-gimpimageguides.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp3-gimpimageselect.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-gimpimagesamplepoints"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-gimpimagesamplepoints.top_of_page"></a>gimpimagesamplepoints</span></h2>
<p>gimpimagesamplepoints — Functions for manipulating an image's sample points.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-gimpimagesamplepoints.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpimagesamplepoints.html#gimp-image-add-sample-point" title="gimp_image_add_sample_point ()">gimp_image_add_sample_point</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpimagesamplepoints.html#gimp-image-delete-sample-point" title="gimp_image_delete_sample_point ()">gimp_image_delete_sample_point</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpimagesamplepoints.html#gimp-image-find-next-sample-point" title="gimp_image_find_next_sample_point ()">gimp_image_find_next_sample_point</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpimagesamplepoints.html#gimp-image-get-sample-point-position" title="gimp_image_get_sample_point_position ()">gimp_image_get_sample_point_position</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpimagesamplepoints.description"></a><h2>Description</h2>
<p>Functions for manipulating an image's sample points.</p>
</div>
<div class="refsect1">
<a name="libgimp3-gimpimagesamplepoints.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-image-add-sample-point"></a><h3>gimp_image_add_sample_point ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gimp_image_add_sample_point (<em class="parameter"><code><a class="link" href="GimpImage.html" title="gimpimage"><span class="type">GimpImage</span></a> *image</code></em>,
                             <em class="parameter"><code><span class="type">gint</span> position_x</code></em>,
                             <em class="parameter"><code><span class="type">gint</span> position_y</code></em>);</pre>
<p>Add a sample point to an image.</p>
<p>This procedure adds a sample point to an image. It takes the input
image and the position of the new sample points as parameters. It
returns the sample point ID of the new sample point.</p>
<div class="refsect3">
<a name="gimp-image-add-sample-point.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>image</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position_x</p></td>
<td class="parameter_description"><p>The guide'sample points x-offset from left of image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position_y</p></td>
<td class="parameter_description"><p>The guide'sample points y-offset from top of image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-add-sample-point.returns"></a><h4>Returns</h4>
<p> The new sample point.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-delete-sample-point"></a><h3>gimp_image_delete_sample_point ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_delete_sample_point (<em class="parameter"><code><a class="link" href="GimpImage.html" title="gimpimage"><span class="type">GimpImage</span></a> *image</code></em>,
                                <em class="parameter"><code><span class="type">guint</span> sample_point</code></em>);</pre>
<p>Deletes a sample point from an image.</p>
<p>This procedure takes an image and a sample point ID as input and
removes the specified sample point from the specified image.</p>
<div class="refsect3">
<a name="gimp-image-delete-sample-point.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>image</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sample_point</p></td>
<td class="parameter_description"><p>The ID of the sample point to be removed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-delete-sample-point.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-find-next-sample-point"></a><h3>gimp_image_find_next_sample_point ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gimp_image_find_next_sample_point (<em class="parameter"><code><a class="link" href="GimpImage.html" title="gimpimage"><span class="type">GimpImage</span></a> *image</code></em>,
                                   <em class="parameter"><code><span class="type">guint</span> sample_point</code></em>);</pre>
<p>Find next sample point on an image.</p>
<p>This procedure takes an image and a sample point ID as input and
finds the sample point ID of the successor of the given sample point
ID in the image's sample point list. If the supplied sample point ID
is 0, the procedure will return the first sample point. The
procedure will return 0 if given the final sample point ID as an
argument or the image has no sample points.</p>
<div class="refsect3">
<a name="gimp-image-find-next-sample-point.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>image</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sample_point</p></td>
<td class="parameter_description"><p>The ID of the current sample point (0 if first invocation).</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-find-next-sample-point.returns"></a><h4>Returns</h4>
<p> The next sample point's ID.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-get-sample-point-position"></a><h3>gimp_image_get_sample_point_position ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_image_get_sample_point_position (<em class="parameter"><code><a class="link" href="GimpImage.html" title="gimpimage"><span class="type">GimpImage</span></a> *image</code></em>,
                                      <em class="parameter"><code><span class="type">guint</span> sample_point</code></em>,
                                      <em class="parameter"><code><span class="type">gint</span> *position_y</code></em>);</pre>
<p>Get position of a sample point on an image.</p>
<p>This procedure takes an image and a sample point ID as input and
returns the position of the sample point relative to the top and
left of the image.</p>
<div class="refsect3">
<a name="gimp-image-get-sample-point-position.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>image</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sample_point</p></td>
<td class="parameter_description"><p>The guide.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position_y</p></td>
<td class="parameter_description"><p>The sample points's position relative to top of image. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-get-sample-point-position.returns"></a><h4>Returns</h4>
<p> The sample points's position relative to top of image.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>